メインコンテンツまでスキップ
バージョン: DAI 7.4

Eggplant Public API

Version 0.1.0

パステーブル

メソッドパス説明
POST/authクライアントIDとシークレットからアクセストークンを取得する
GET/test_resultsテスト結果の表示
GET/test_results/{test_result_id}1回のテストの結果を取得する
GET/test_results/{test_result_id}/logs単一のテストのログを取得する
GET/test_results/{test_result_id}/screenshotsテストに利用可能なスクリーンショットを一覧表示する
GET/screenshots/{screenshot_id}テスト結果のスクリーンショットをダウンロードする

参照表

名前タイプ説明
AuthRequestBodyスキーマ
AuthResponseBodyスキーマ
HTTPValidationErrorスキーマ
Problemスキーマ
RunTypeスキーマ特定のテスト結果に対して実行可能なタイプ。
Screenshotスキーマ特定のテスト結果の利用可能なスクリーンショットの情報。
ScreenshotsPaginatedListスキーマ利用可能な単一のテスト結果のスクリーンショットのページ分けされたリスト。
Severityスキーマ単一のテスト結果ログ エントリの重大度レベル。
SortByスキーマテスト結果のリストを並べ替えるために使用できる並べ替えオプション。
SortDirectionスキーマソート中に適用される可能性のある方向。
Statusスキーマ特定のテスト結果の可能なステータス。
TestResultスキーマ単一の探索、再生、またはテスト ケース実行に関するすべての情報が含まれるテスト結果。
TestResultLogEntriesPaginatedListスキーマ単一のテスト結果ログ エントリのページ区切りリスト。
TestResultLogEntryスキーマ特定のテスト結果からの単一のログ エントリ。
TestResultsPaginatedListスキーマテスト結果のページ分けされたリスト。
ValidationErrorスキーマ

パスの詳細

[POST] /auth

Summary:
クライアントIDとシークレットからアクセストークンを取得する

RequestBody

application/json

{
client_id: string
client_secret: string
}

Responses

200 OK

application/json

{
access_token: string
expires_in: integer
}
401 Unauthorized

application/json

{
status: integer //default: 400
title: Partial(string) & Partial(null)
detail: Partial(string) & Partial(null)
type: Partial(string) & Partial(null)
}
422 Validation Error

application/json

{
detail: {
loc: Partial(string) & Partial(integer)[]
msg: string
type: string
}[]
}

[GET] /test_results

Summary:
テスト結果を一覧表示する

Description:
適用されたフィルターに一致するテスト結果のページ区切りリストを取得します。

Parameters (Query)

//
// 適用されたフィルターに一致するが返されるリストから除外される、先頭のテスト結果の数。
//
オフセット: 整数
// 返されるテスト結果の最大数。<br>*注*: 制限の最大値は、システム環境変数の LIMIT_MAX_VALUE を設定することで変更できます。LIMIT_MAX_VALUE の許容範囲は 1000 ~ 2147483647 です。
limit: integer //default: 1000
//
// 返されるテスト結果項目の順序を決定するために使用されるキー。
//
sort_by: SortBy
// 
//ソート時にテスト結果項目に適用される順序方向。
//
sort_direction: SortDirection
//
// 特定のテスト結果ステータスでテスト結果をフィルタリングします。
//
status: Status
//
// テスト結果をフィルタリングして、指定された時間以降に開始されたものを取得します。<br>
// *デフォルト値* : null
//
start_time: 文字列
//
// 指定された時間より前に終了したテスト結果を取得するためにフィルター処理します。<br>
// *デフォルト値* : null
//
end_time: 文字列
/
// テスト結果をフィルタリングして、指定された model_id.<br> に一致するモデルを使用するテスト結果を取得します
// *デフォルト値* : null
//
model_id: 文字列
//
// テスト結果をフィルタリングして、指定された suite_id.<br> に一致するスイートを使用するスクリプト化されたテスト結果を取得します
// *デフォルト値* : null
//
suite_id: 文字列
//
// 指定された test_case_id.<br> のすべてのテスト結果を取得します
// *デフォルト値* : null
//
test_case_id: 文字列
//
// この実行環境 Id を実行に使用するすべてのテスト結果を取得します。<br>
// *デフォルト値* : null
//
実行環境 Id: 整数
//
// この sut_id に一致する sut を使用して実行したすべてのテスト結果を取得します。<br>
// *デフォルト値* : null
//
sut_id: 文字列
//
// 指定された task_instance_id.<br> に一致するテスト構成実行の一部であるすべてのテスト結果を取得します
// *デフォルト値* : null
//
test_config_result_id: 文字列
//
// 指定された test_config_id.<br> のすべてのテスト結果を取得します
// *デフォルト値* : null
//
test_config_id: 文字列

Headers

// POST /auth エンドポイントから返される access_token。
authorization: string

Responses

200 OK

application/json

// テスト結果のページ区切りリスト。
{
// 制限またはオフセットが適用される前の、リクエストに一致するアイテムの合計数。
total_count: integer
// このリクエストが行われた日時。
date_as_of: string
// 単一の探索、再生、またはテスト ケース実行のすべての情報を含むテスト結果。
items: {
// テスト結果 ID。
id: integer
// 特定のテスト結果の可能なステータス。
status: enum[RUNNINGPASSEDFAILEDERRORCANCELLED]
// 特定のテスト結果の可能な実行タイプ。
run_type: enum[SCRIPTED_TEST_CASEMODEL_TEST_CASEEXPLORATORYREPLAY]
// このテスト結果が、テスト構成で構成された再実行試行の一部であったかどうか。
is_rerun: boolean
// テスト実行が開始された時刻。
start_time: string
// テスト実行が完了した時刻。まだ実行中の場合、これは null になります。
end_time: Partial(string) & Partial(null)
// テスト実行に使用されたモデルの名前。これがスクリプト化されたテスト ケースの結果である場合、これは null になります。
model_name: Partial(string) & Partial(null)
// テスト実行に使用されたモデルの ID。これがスクリプト化されたテスト ケースの結果である場合、これは null になります。
model_id: Partial(string) & Partial(null)
// テスト実行に使用されたスイートの名前。
suite_name: Partial(string) & Partial(null)
// テスト実行に使用されたスイートの ID。
suite_id: Partial(string) & Partial(null)
// 実行中のテスト ケースの名前。探索的テストまたは再生テストの結果の場合、これは null になります。
test_case_name: Partial(string) & Partial(null)
// 実行されたテスト ケースの ID。探索的または再生テスト結果の場合、これは null になります。
test_case_id: Partial(string) & Partial(null)
// テスト実行に使用される設計エージェントまたは実行エージェントの名前
execution_environment_name: Partial(string) & Partial(null)
// テスト実行に使用される設計エージェントまたは実行エージェントの ID。
execution_environment_id: Partial(integer) & Partial(null)
// テスト実行に使用される SUT の名前。
sut_name: Partial(string) & Partial(null)
// テスト実行に使用される SUT の ID。
sut_id: Partial(string) & Partial(null)
// このテスト結果が含まれるテスト構成結果の ID。ライブ実行の場合、これは null になります。
test_config_result_id: Partial(string) & Partial(null)
// このテスト結果が表すテスト構成ステップ。これはゼロインデックスで、ライブ実行結果の場合は null になります。
test_config_step: Partial(integer) & Partial(null)
}[]
}
400 Bad request

application/json

{
status: integer //default: 400
title: Partial(string) & Partial(null)
detail: Partial(string) & Partial(null)
type: Partial(string) & Partial(null)
}
401 Unauthorized

application/json

{
status: integer //default: 400
title: Partial(string) & Partial(null)
detail: Partial(string) & Partial(null)
type: Partial(string) & Partial(null)
}
422 Validation Error

application/json

{
detail: {
loc: Partial(string) & Partial(integer)[]
msg: string
type: string
}[]
}

[GET] /test_results/{test_result_id}

Summary:
1回のテストの結果を取得する

Description:
指定された test_result_id のテスト結果を取得します。

Headers

// POST /auth エンドポイントから返される access_token。
authorization: 文字列

Responses

200 テスト結果が正常に取得されました

application/json

// 単一の探索、再生、またはテスト ケース実行に関するすべての情報を含むテスト結果。
{
// テスト結果 ID。
id: integer
// 特定のテスト結果の可能なステータス。
status: enum[RUNNINGPASSEDFAILEDERRORCANCELLED]
// 特定のテスト結果の可能な実行タイプ。
run_type: enum[SCRIPTED_TEST_CASEMODEL_TEST_CASEEXPLORATORYREPLAY]
// このテスト結果が、テスト構成で構成された再実行試行の一部であったかどうか。
is_rerun: boolean
// テスト実行が開始された時刻。
start_time: string
// テスト実行が完了した時刻。まだ実行中の場合は null になります。
end_time: Partial(string) & Partial(null)
// テスト実行に使用されたモデルの名前。これがスクリプト化されたテスト ケース結果だった場合は null になります。
model_name: Partial(string) & Partial(null)
// テスト実行に使用されたモデルの ID。これがスクリプト化されたテスト ケースの結果である場合、これは null になります。
model_id: Partial(string) & Partial(null)
// テスト実行に使用されたスイートの名前。
suite_name: Partial(string) & Partial(null)
// テスト実行に使用されたスイートの ID。
suite_id: Partial(string) & Partial(null)
// 実行中のテスト ケースの名前。探索的または再生テストの結果の場合、これは null になります。
test_case_name: Partial(string) & Partial(null)
// 実行されたテスト ケースの ID。探索的または再生テストの結果の場合、これは null になります。
test_case_id: Partial(string) & Partial(null)
// テスト実行に使用される設計エージェントまたは実行エージェントの名前
execution_environment_name: Partial(string) & Partial(null)
// テスト実行に使用される設計エージェントまたは実行エージェントの ID。
execution_environment_id: Partial(integer) & Partial(null)
// テスト実行に使用される SUT の名前。
sut_name: Partial(string) & Partial(null)
// テスト実行に使用される SUT の ID。
sut_id: Partial(string) & Partial(null)
// このテスト結果が含まれるテスト構成結果の ID。ライブ実行の場合、これは null になります。
test_config_result_id: Partial(string) & Partial(null)
// このテスト結果が表すテスト構成ステップ。これはゼロインデックスで、ライブ実行結果の場合は null になります。
test_config_step: Partial(integer) & Partial(null)
}
400 Bad request

application/json

{
status: integer //default: 400
title: Partial(string) & Partial(null)
detail: Partial(string) & Partial(null)
type: Partial(string) & Partial(null)
}
401 Unauthorized

application/json

{
status: integer //default: 400
title: Partial(string) & Partial(null)
detail: Partial(string) & Partial(null)
type: Partial(string) & Partial(null)
}
403 Access denied

application/json

{
status: integer //default: 400
title: Partial(string) & Partial(null)
detail: Partial(string) & Partial(null)
type: Partial(string) & Partial(null)
}
404 テスト結果が見つかりません

application/json

{
status: integer //default: 400
title: Partial(string) & Partial(null)
detail: Partial(string) & Partial(null)
type: Partial(string) & Partial(null)
}
422 Validation Error

application/json

{
detail: {
loc: Partial(string) & Partial(integer)[]
msg: string
type: string
}[]
}

[GET] /test_results/{test_result_id}/logs

Summary:
単一のテストのログを取得する

Description:
単一のテスト結果のログのページ分割されたリストを取得します。

Parameters (Query)

// 返されるリストから除外される、先頭のテスト結果ログエントリの数。
offset: integer
// 返されるテスト結果ログエントリの最大数。<br>*注*: 制限の最大値は、システム環境変数の LIMIT_MAX_VALUE を設定することで変更できます。LIMIT_MAX_VALUE の許容範囲は 1000 ~ 2147483647 です。
limit: integer //default: 1000

Headers

// POST /auth エンドポイントから返される access_token。
authorization: 文字列

Responses

200 テスト結果ログが正常に取得されました。

application/json

// 1 つのテスト結果のログ エントリのページ区切りリスト。
{
// 制限またはオフセットが適用される前の、リクエストに一致するアイテムの合計数。
total_count: integer
// このリクエストが行われた日時。
date_as_of: string
// 特定のテスト結果からの 1 つのログ エントリ。
items: {
// このログ エントリが含まれるテスト結果の ID。
test_result_id: integer
// このログ エントリが作成されたタイムスタンプ。
timestamp: string
// このテスト結果のログ エントリで伝えられるメッセージ。
message: string
// 1 つのテスト結果のログ エントリの重大度レベル。
severity: enum[CRITICALERRORWARNINGINFODEBUG]
}[]
}
400 Bad request

application/json

{
status: integer //default: 400
title: Partial(string) & Partial(null)
detail: Partial(string) & Partial(null)
type: Partial(string) & Partial(null)
}
401 Unauthorized

application/json

{
status: integer //default: 400
title: Partial(string) & Partial(null)
detail: Partial(string) & Partial(null)
type: Partial(string) & Partial(null)
}
403 アクセスが拒否されました

application/json

{
status: integer //default: 400
title: Partial(string) & Partial(null)
detail: Partial(string) & Partial(null)
type: Partial(string) & Partial(null)
}
404 テスト結果が見つかりません

application/json

{
status: integer //default: 400
title: Partial(string) & Partial(null)
detail: Partial(string) & Partial(null)
type: Partial(string) & Partial(null)
}
422 検証エラー

application/json

{
detail: {
loc: Partial(string) & Partial(integer)[]
msg: string
type: string
}[]
}

[GET] /test_results/{test_result_id}/screenshots

Summary:
テストに利用可能なスクリーンショットを一覧表示する

Description:
指定された test_result_id で指定されたテストで使用可能なスクリーンショットのページ区切りリストを取得します。

パラメータ (クエリ)

//
// 返されるリストから除外される、最初に利用可能なスクリーンショットの数。
//
オフセット: 整数
//
// 返されるスクリーンショットの最大数。<br>
// *デフォルト値* : null
//
制限: 整数 // デフォルト: 1000

Headers

// POST /auth エンドポイントから返される access_token。
authorization: 文字列

Responses

利用可能なスクリーンショット 200 枚が正常に取得されました。

application/json

// 利用可能な単一のテスト結果のスクリーンショットのページ区切りリスト。
{
// 制限またはオフセットが適用される前の、リクエストに一致するアイテムの合計数。
total_count: integer
// このリクエストが行われた日時。
date_as_of: string
// 特定のテスト結果の利用可能なスクリーンショットの情報。
items: {
// このスクリーンショットのアーティファクト Id。
id: string
// このスクリーンショットが作成されたタイムスタンプ。
timestamp: string
// このスクリーンショットの画像形式。
content_type: string
}[]
}
400 Bad request

application/json

{
status: integer //default: 400
title: Partial(string) & Partial(null)
detail: Partial(string) & Partial(null)
type: Partial(string) & Partial(null)
}
401 Unauthorized

application/json

{
status: integer //default: 400
title: Partial(string) & Partial(null)
detail: Partial(string) & Partial(null)
type: Partial(string) & Partial(null)
}
403 アクセスが拒否されました

application/json

{
status: integer //default: 400
title: Partial(string) & Partial(null)
detail: Partial(string) & Partial(null)
type: Partial(string) & Partial(null)
}
404 テスト結果が見つかりません

application/json

{
status: integer //default: 400
title: Partial(string) & Partial(null)
detail: Partial(string) & Partial(null)
type: Partial(string) & Partial(null)
}
422 検証エラー

application/json

{
detail: {
loc: Partial(string) & Partial(integer)[]
msg: string
type: string
}[]
}

[GET] /screenshots/{screenshot_id}

Summary:
テスト結果のスクリーンショットをダウンロードする

Description:
指定された screenshot_id のスクリーンショットをダウンロードします。

Headers

// POST /auth エンドポイントから返される access_token。
authorization: 文字列

Responses

200 関心のあるスクリーンショット(バイト単位)。

image/png image/tiff image/jpeg

400 Bad request

application/json

{
status: integer //default: 400
title: Partial(string) & Partial(null)
detail: Partial(string) & Partial(null)
type: Partial(string) & Partial(null)
}
401 Unauthorized

application/json

{
status: integer //default: 400
title: Partial(string) & Partial(null)
detail: Partial(string) & Partial(null)
type: Partial(string) & Partial(null)
}
404 テスト結果のスクリーンショットが見つかりません。

application/json

{
status: integer //default: 400
title: Partial(string) & Partial(null)
detail: Partial(string) & Partial(null)
type: Partial(string) & Partial(null)
}
422 Validation Error

application/json

{
detail: {
loc: Partial(string) & Partial(integer)[]
msg: string
type: string
}[]
}

References

AuthRequestBody

{
client_id: string
client_secret: string
}

AuthResponseBody

{
access_token: string
expires_in: integer
}

HTTPValidationError

{
detail: {
loc: Partial(string) & Partial(integer)[]
msg: string
type: string
}[]
}

Problem

{
status: integer //default: 400
title: Partial(string) & Partial(null)
detail: Partial(string) & Partial(null)
type: Partial(string) & Partial(null)
}

RunType

{
"type": "string",
"enum": [
"SCRIPTED_TEST_CASE",
"MODEL_TEST_CASE",
"EXPLORATORY",
"REPLAY"
],
"title": "RunType",
"description": "The possible run types for a particular test result."
}

Screenshot

// 特定のテスト結果の利用可能なスクリーンショットの情報。
{
// このスクリーンショットのアーティファクト Id。
id: string
// このスクリーンショットが作成されたタイムスタンプ。
timestamp: string
// このスクリーンショットの画像形式。
content_type: string
}

ScreenshotsPaginatedList

// 利用可能な単一のテスト結果のスクリーンショットのページ区切りリスト。
{
// 制限またはオフセットが適用される前の、リクエストに一致するアイテムの合計数。
total_count: integer
// このリクエストが行われた日時。
date_as_of: string
// 特定のテスト結果の利用可能なスクリーンショットの情報。
items: {
// このスクリーンショットのアーティファクト Id。
id: string
// このスクリーンショットが作成されたタイムスタンプ。
timestamp: string
// このスクリーンショットの画像形式。
content_type: string
}[]
}

Severity

{
"type": "string",
"enum": [
"CRITICAL",
"ERROR",
"WARNING",
"INFO",
"DEBUG"
],
"title": "Severity",
"description": "The severity levels of a single test result log entry."
}

SortBy

{
"type": "string",
"enum": [
"id",
"model_or_suite_name",
"start_time",
"test_case_name",
"test_config_name",
"execution_environment_name",
"sut_name"
],
"title": "SortBy",
"description": "The possible sorting options available for sorting a list of test results."
}

SortDirection

{
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "SortDirection",
"description": "The possible direction applied during sorting."
}

Status

{
"type": "string",
"enum": [
"RUNNING",
"PASSED",
"FAILED",
"ERROR",
"CANCELLED"
],
"title": "Status",
"description": "The possible statuses for a particular test result."
}

TestResult

// 単一の探索、再生、またはテスト ケース実行に関するすべての情報を含むテスト結果。
{
// テスト結果 ID。
id: integer
// 特定のテスト結果の可能なステータス。
status: enum[RUNNINGPASSEDFAILEDERRORCANCELLED]
// 特定のテスト結果の可能な実行タイプ。
run_type: enum[SCRIPTED_TEST_CASEMODEL_TEST_CASEEXPLORATORYREPLAY]
// このテスト結果が、テスト構成で構成された再実行試行の一部であったかどうか。
is_rerun: boolean
// テスト実行が開始された時刻。
start_time: string
// テスト実行が完了した時刻。まだ実行中の場合は null になります。
end_time: Partial(string) & Partial(null)
// テスト実行に使用されたモデルの名前。これがスクリプト化されたテスト ケース結果だった場合は null になります。
model_name: Partial(string) & Partial(null)
// テスト実行に使用されたモデルの ID。これがスクリプト化されたテスト ケースの結果である場合、これは null になります。
model_id: Partial(string) & Partial(null)
// テスト実行に使用されたスイートの名前。
suite_name: Partial(string) & Partial(null)
// テスト実行に使用されたスイートの ID。
suite_id: Partial(string) & Partial(null)
// 実行中のテスト ケースの名前。探索的または再生テストの結果の場合、これは null になります。
test_case_name: Partial(string) & Partial(null)
// 実行されたテスト ケースの ID。探索的または再生テストの結果の場合、これは null になります。
test_case_id: Partial(string) & Partial(null)
// テスト実行に使用される設計エージェントまたは実行エージェントの名前
execution_environment_name: Partial(string) & Partial(null)
// テスト実行に使用される設計エージェントまたは実行エージェントの ID。
execution_environment_id: Partial(integer) & Partial(null)
// テスト実行に使用される SUT の名前。
sut_name: Partial(string) & Partial(null)
// テスト実行に使用される SUT の ID。
sut_id: Partial(string) & Partial(null)
// このテスト結果が含まれるテスト構成結果の ID。ライブ実行の場合、これは null になります。
test_config_result_id: Partial(string) & Partial(null)
// このテスト結果が表すテスト構成ステップ。これはゼロインデックスで、ライブ実行結果の場合は null になります。
test_config_step: Partial(integer) & Partial(null)
}

TestResultLogEntriesPaginatedList

// 1 つのテスト結果のログ エントリのページ区切りリスト。
{
// 制限またはオフセットが適用される前の、リクエストに一致するアイテムの合計数。
total_count: integer
// このリクエストが行われた日時。
date_as_of: string
// 特定のテスト結果からの 1 つのログ エントリ。
items: {
// このログ エントリが含まれるテスト結果の ID。
test_result_id: integer
// このログ エントリが作成されたタイムスタンプ。
timestamp: string
// このテスト結果のログ エントリで伝えられるメッセージ。
message: string
// 1 つのテスト結果のログ エントリの重大度レベル。
severity: enum[CRITICALERRORWARNINGINFODEBUG]
}[]
}

TestResultLogEntry

// 特定のテスト結果からの単一のログ エントリ。
{
// このログ エントリが含まれるテスト結果の ID。
test_result_id: integer
// このログ エントリが作成されたタイムスタンプ。
timestamp: string
// このテスト結果ログ エントリで伝えられるメッセージ。
message: string
// 単一のテスト結果ログ エントリの重大度レベル。
severity: enum[CRITICALERRORWARNINGINFODEBUG]
}

TestResultsPaginatedList

// テスト結果のページ区切りリスト。
{
// 制限またはオフセットが適用される前の、リクエストに一致するアイテムの合計数。
total_count: integer
// このリクエストが行われた日時。
date_as_of: string
// 単一の探索、再生、またはテスト ケース実行のすべての情報を含むテスト結果。
items: {
// テスト結果 ID。
id: integer
// 特定のテスト結果の可能なステータス。
status: enum[RUNNINGPASSEDFAILEDERRORCANCELLED]
// 特定のテスト結果の可能な実行タイプ。
run_type: enum[SCRIPTED_TEST_CASEMODEL_TEST_CASEEXPLORATORYREPLAY]
// このテスト結果が、テスト構成で構成された再実行試行の一部であったかどうか。
is_rerun: boolean
// テスト実行が開始された時刻。
start_time: string
// テスト実行が完了した時刻。まだ実行中の場合、これは null になります。
end_time: Partial(string) & Partial(null)
// テスト実行に使用されたモデルの名前。これがスクリプト化されたテスト ケースの結果である場合、これは null になります。
model_name: Partial(string) & Partial(null)
// テスト実行に使用されたモデルの ID。これがスクリプト化されたテスト ケースの結果である場合、これは null になります。
model_id: Partial(string) & Partial(null)
// テスト実行に使用されたスイートの名前。
suite_name: Partial(string) & Partial(null)
// テスト実行に使用されたスイートの ID。
suite_id: Partial(string) & Partial(null)
// 実行中のテスト ケースの名前。探索的テストまたは再生テストの結果の場合、これは null になります。
test_case_name: Partial(string) & Partial(null)
// 実行されたテスト ケースの ID。探索的または再生テスト結果の場合、これは null になります。
test_case_id: Partial(string) & Partial(null)
// テスト実行に使用される設計エージェントまたは実行エージェントの名前
execution_environment_name: Partial(string) & Partial(null)
// テスト実行に使用される設計エージェントまたは実行エージェントの ID。
execution_environment_id: Partial(integer) & Partial(null)
// テスト実行に使用される SUT の名前。
sut_name: Partial(string) & Partial(null)
// テスト実行に使用される SUT の ID。
sut_id: Partial(string) & Partial(null)
// このテスト結果が含まれるテスト構成結果の ID。ライブ実行の場合、これは null になります。
test_config_result_id: Partial(string) & Partial(null)
// このテスト結果が表すテスト構成ステップ。これはゼロインデックスで、ライブ実行結果の場合は null になります。
test_config_step: Partial(integer) & Partial(null)
}[]
}

ValidationError

{
loc: Partial(string) & Partial(integer)[]
msg: string
type: string
}